/*
 * Copyright (c) 2025 Oracle and/or its affiliates.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.helidon.testing.junit5.suite;

import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import io.helidon.testing.junit5.suite.spi.SuiteProvider;

import org.junit.jupiter.api.extension.ExtendWith;

/**
 * Test suite annotations.
 *
 * @deprecated this is a feature in progress of development, there may be backward incompatible changes done to it, so please
 *         use with care
 */
@Deprecated
public final class TestSuite {

    private TestSuite() {
    }

    /**
     * Test suite annotation.
     *
     * @deprecated this is a feature in progress of development, there may be backward incompatible changes done to it, so please
     *         use with care
     */
    @Deprecated
    @Retention(RetentionPolicy.RUNTIME)
    @Target(ElementType.TYPE)
    @ExtendWith(SuiteExtension.class)
    @Inherited
    public @interface Suite {

        /**
         * Suite provider class.
         *
         * @return the provider class
         */
        Class<? extends SuiteProvider> value();
    }

    /**
     * After {@link io.helidon.testing.junit5.suite.TestSuite} cleanup method.
     *
     * @deprecated this is a feature in progress of development, there may be backward incompatible changes done to it, so please
     *         use with care
     */
    @Deprecated
    @Retention(RetentionPolicy.RUNTIME)
    @Target(ElementType.METHOD)
    @Inherited
    public @interface AfterSuite {
    }

    /**
     * Before {@link io.helidon.testing.junit5.suite.TestSuite} initialization method.
     *
     * @deprecated this is a feature in progress of development, there may be backward incompatible changes done to it, so please
     *         use with care
     */
    @Deprecated@Retention(RetentionPolicy.RUNTIME)
    @Target(ElementType.METHOD)
    @Inherited
    public @interface BeforeSuite {
    }
}
